/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.deployment;

import java.util.Enumeration;

import javax.xml.soap.SOAPMessage;

import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;

/** Encapsulates the context of the message currently under processing. It is
    possible for an entity to retrieve the javax.xml.SOAPMessage or the 
    equivalent EnvelopeDocument. The SOAPContext class also contains methods
    which will allow different filters within the filter pipeline to exchange
    state and other variable if so needed. Note that we need this wrapper so 
    that filters that modify/replace the SOAP message will see their changes
    propagated to other filters. After a filter hass processed the SOAP message
    the right way to retrieve the SOAP message is to use the getSOAPMessage()
    method.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:29 $
    $Revision: 1.3 $
*/

public interface SOAPContext {
  /** Get the underlying SOAP message. */
  public SOAPMessage getSOAPMessage();

  /** Set the soap message for the context. */
  public void setSOAPMessage(SOAPMessage soapMessage);

  /** Retrieve the envelope document. */
  public EnvelopeDocument getEnvelopeDocument();

  /** Set the envelope document. */
  public void setEnvelopeDocument(EnvelopeDocument envelopeDocument);

  /** Check to see if the SOAPContext encapsulates a SOAPMessage. */
  public boolean encapsulatesSOAPMessage();

  /** Check to see if the SOAPContext encapsulates an EnvelopeDocument. */
  public boolean encapsulatesEnvelopeDocument();
  
  /** Retrieves the value associated with the specified propertyName. */
  public Object getProperty(String propertyName);

  /** Check to see if there is a property corresponding to the specified
      property name. */
  public boolean hasProperty(String propertyName);

  /** Removes the propertyName-Value combination associated with the specified
      propety name. */
  public void removeProperty(String propertyName);

  /** Adds/Replaces a property with specified value. */
  public void setProperty(String propertyName, Object value);

  /** Returns an enumeration of the properties encapsulated within the 
      SOAPContext. */
  public Enumeration propertyNames();
  

}
